Copies a source buffer to a destination image. More...

#include <kanzi/gfx/commands.hpp>

Inheritance diagram for kanzi::gfx::CopyBufferToImageCommand:

Public Member Functions
	CopyBufferToImageCommand ()
	Constructor.

Public Member Functions inherited from kanzi::gfx::BaseCommand
uint32_t	getSize () const
	Gets the command size in bytes.

uint8_t	getTag () const
	Gets the command tag.

CommandType	getType () const
	Gets the command type.

void	setTag (uint8_t tag)
	Sets the command tag.

Public Attributes
ImageHandleGuard	destinationImage
	The destination image. Must have ImageUsageFlag::CopyDestination.

box3u32	destinationRegion
	The destination image region.

ImageSubresource	destinationSubresource
	The destination subresource.

BufferHandleGuard	sourceBuffer
	The source buffer. Must have BufferUsageFlag::CopySource.

uint32_t	sourceImageHeight
	The source height for 3D textures. Value 0 assumes the data is tightly packed according to image dimensions.

uint32_t	sourceOffset
	The source offset in bytes.

uint32_t	sourceRowLength
	The source row length in pixels. Value 0 assumes the data is tightly packed according to image dimensions.

Additional Inherited Members
Protected Member Functions inherited from kanzi::gfx::BaseCommand
	BaseCommand (CommandType t, uint32_t s)
	Constructor.

	BaseCommand (const BaseCommand &other)
	Copy Constructor.

BaseCommand &	operator= (const BaseCommand &other)
	Assignment operator.

Detailed Description

Copies a source buffer to a destination image.

Since: Kanzi 4.0.0

Constructor & Destructor Documentation

◆ CopyBufferToImageCommand()

kanzi::gfx::CopyBufferToImageCommand::CopyBufferToImageCommand ( )

inline

Constructor.

Member Data Documentation

◆ sourceBuffer

BufferHandleGuard kanzi::gfx::CopyBufferToImageCommand::sourceBuffer

The source buffer. Must have BufferUsageFlag::CopySource.

◆ sourceOffset

uint32_t kanzi::gfx::CopyBufferToImageCommand::sourceOffset

The source offset in bytes.

◆ sourceRowLength

uint32_t kanzi::gfx::CopyBufferToImageCommand::sourceRowLength

The source row length in pixels. Value 0 assumes the data is tightly packed according to image dimensions.

◆ sourceImageHeight

uint32_t kanzi::gfx::CopyBufferToImageCommand::sourceImageHeight

The source height for 3D textures. Value 0 assumes the data is tightly packed according to image dimensions.

◆ destinationImage

ImageHandleGuard kanzi::gfx::CopyBufferToImageCommand::destinationImage

The destination image. Must have ImageUsageFlag::CopyDestination.

◆ destinationRegion

box3u32 kanzi::gfx::CopyBufferToImageCommand::destinationRegion

The destination image region.

◆ destinationSubresource

ImageSubresource kanzi::gfx::CopyBufferToImageCommand::destinationSubresource

The destination subresource.

The documentation for this struct was generated from the following file:

kanzi/gfx/commands.hpp

Public Member Functions

Public Attributes

Additional Inherited Members